/*
 * Created on 2006-6-28
 *
 * TODO To change the template for this generated file go to
 * Window - Preferences - Java - Code Style - Code Templates
 */
package com.powerunion.datacollection.report.excelreport;

import java.util.Map;

import com.powerunion.datacollection.report.excelreport.config.ReportConfig;


/**
 * 用户嵌入类接口：客户程序可以在配置文件中为某个报表配置一个嵌入类，
 * 通过该类可以在报表生成前用户可以参与数据源的生成和控制等操作。该类有一个基本实现类ReportEntry
 * @see net.excel.report.ReportEntry
 * @author juny
 */
public interface IReportEntry {  
    /**
     * 用户嵌入类执行函数，报表框架程序会在读入配置文件信息，
     * 并构建相应的数据源对象和参数信息后调用该函数。
     * @param reportConfig 对应报表的配置信息对象
     * @param dataSources 报表的数据源列表
     * （Map中以key=数据源名称；value=DataSourceObject的格式保存）
     * @param params 参数列表（key=参数名称; value=参数值)
     * @return true 函数执行成功； false 函数执行失败。
     * @throws Exception 
     */
    public boolean execute ( 
            ReportConfig reportConfig, //报表配置参数对象
            Map dataSources, 		   //报表数据源
            Map params 				   //传入参数。
            )throws Exception;
}
